Add Gmail client and update email functions #944
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michplunkett
commented
Jun 27, 2023
michplunkett
commented
Jun 27, 2023
michplunkett
changed the title
michplunkett
changed the title
michplunkett
commented
Jul 5, 2023
| subject = ( | ||
| f"{current_app.config.get('OO_MAIL_SUBJECT_PREFIX')} Reset Your Password" | ||
| ) | ||
| body = render_template("auth/email/reset_password.html", user=user, token=token) |
There was a problem hiding this comment.
michplunkett
commented
Jul 5, 2023
Comment on lines
+53
to
+67
| **NOTE:** If you are running on dev and do not currently have a `service_account_key.json` file, create one and leave it empty. The email client will then default to an empty object and simulate emails in the logs. | ||
|
|
||
| For the application to work properly, you will need a [Google Cloud Platform service account](https://cloud.google.com/iam/docs/service-account-overview) that is attached to a GSuite email address. Here are some general tips for working with service accounts: [Link](https://support.google.com/a/answer/7378726?hl=en). | ||
| We would suggest that you do not use a personal email address, but instead one that is used strictly for sending out OpenOversight emails. | ||
|
|
||
| You will need to do these two things for the service account to work as a Gmail bot: | ||
| 1. Enable domain-wide delegation for the service account: [Link](https://support.google.com/a/answer/162106?hl=en) | ||
| 2. Enable the `https://www.googleapis.com/auth/gmail.send` scope in the Gmail API for your service account: [Link](https://developers.google.com/gmail/api/auth/scopes#scopes) | ||
| 3. Save the service account key file in OpenOversight's base folder as `service_account_key.json`. The file is in the `.gitignore` file GitHub will not allow you to save it, provided you've named it correctly. | ||
| 4. For production, save the email address associated with your service account to a variable named `OO_SERVICE_EMAIL` in a `.env` file in the base directory of this repository. For development and testing, update the `OO_SERVICE_EMAIL` variable in the `docker-compose.yml` file. | ||
|
|
||
| Example `.env` variable: | ||
| ```bash | ||
| OO_SERVICE_EMAIL="[email protected]" | ||
| ``` |
There was a problem hiding this comment.
This should be all of the info needed, @abandoned-prototype.
abandoned-prototype
approved these changes
Jul 6, 2023
This was referenced Jul 6, 2023
michplunkett
changed the title
sea-kelp
pushed a commit
to OrcaCollective/OpenOversight
that referenced
this pull request
Sep 6, 2023
lucyparsons#927 Add the ability to send emails from a Google Workspace account using a GCP service account and update the feature's respective documentation. - Need `service_account_key.json` file that is stored in LPL document storage. --------- Co-authored-by: abandoned-prototype <[email protected]>
sea-kelp
pushed a commit
to OrcaCollective/OpenOversight
that referenced
this pull request
Sep 25, 2023
lucyparsons#927 Add the ability to send emails from a Google Workspace account using a GCP service account and update the feature's respective documentation. - Need `service_account_key.json` file that is stored in LPL document storage. --------- Co-authored-by: abandoned-prototype <[email protected]>
sea-kelp
pushed a commit
to OrcaCollective/OpenOversight
that referenced
this pull request
Oct 5, 2023
lucyparsons#927 Add the ability to send emails from a Google Workspace account using a GCP service account and update the feature's respective documentation. - Need `service_account_key.json` file that is stored in LPL document storage. --------- Co-authored-by: abandoned-prototype <[email protected]>
AetherUnbound
pushed a commit
to OrcaCollective/OpenOversight
that referenced
this pull request
Oct 9, 2023
lucyparsons#927 Add the ability to send emails from a Google Workspace account using a GCP service account and update the feature's respective documentation. - Need `service_account_key.json` file that is stored in LPL document storage. --------- Co-authored-by: abandoned-prototype <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue
#927
Description of Changes
Add the ability to send emails from a Google Workspace account using a GCP service account and update the feature's respective documentation.
Notes for Deployment
service_account_key.jsonfile that is stored in LPL document storage.Email Screenshots
Administrator Approval Email:
Confirm Account Email:
Change Email Address Email:
Confirmed User Email:
Reset Password Email:
Tests and linting
developbranch.pytestpasses on my local development environment.pre-commitpasses on my local development environment.